************
INTRODUCTION
************

This file describes how to set up and use the Ruby wrapper code with Melissa DATA's Name Object.


*************
PREREQUISITES
*************

To make use of the Name Object Ruby wrapper you will need:

* An installation of a Ruby. This Wrapper tested with Ruby 1.8.6.

* The Melissa DATA Name Object library and data files installed.
  These files are installed automatically if you run setup.exe. By default, the Name Object 
  Library (mdName.dll) is installed in:
	C:\Program Files\Melissa DATA\DQT\NameObj\dll_64bit
		* 32bit version available in C:\Program Files\Melissa DATA\DQT\NameObj\dll_32bit
  and the Name Object data files in:
	C:\Program Files\Melissa DATA\DQT\Data

You will need to know the location of these items in order to install and run the Ruby wrapper.


**********************
Wrapper compatibility
**********************

If the provided pre-compiled wrappers are not compatible with your environment, the necessary files for compilation can be found in the 'interfaces' folder of the object's main directory.



***********
Demo Mode
***********

Please contact your sales representative to obtain a free 30-day license to use Name Object.  After
30 days, the Object must be purchased before continued usage. Please call 1-800-MELISSA ext. 3 for
more information.


*************
Installation
*************

Copy the entire folder that contains this readme.txt into a local directory on your computer.


*****
Setup
*****

You will need to allow mdNameRubyWrapper.dll to find mdName.dll. You can do this by:

	1. Adding the directory containing mdName to your PATH environment variable. 
	   ex: set PATH=%PATH%;C:\Program Files\Melissa DATA\DQT\NameObj\dll_32bit
* 64bit version available in C:\Program Files\Melissa DATA\DQT\NameObj\dll_64bit

	or

	2. Copy mdName.dll into the directory with mdNameRubyWrapper.dll.



**************************
Setting up the Sample Code
**************************

Open mdNameTest.rb for editing. You must set the a license string that you receive from your Melissa Data
sales representative and the path to the mdName data files.

License = "License Here"
DataPath = "C:\\Program Files\\Melissa Data\\DQT\\Data"

***********************
Running the Sample Code
***********************

Navigate to the directory containing the Ruby wrapper using command line and type:
	ruby mdNameSample.rb


*******
Updates
*******

The files generated/included in this wrapper do not need to be changed for DQ Suite updates unless there is a method signature change in the object. If a new method is added, you will need to rebuild the wrapper to use the new method. 


****
Note
****

Here are some general solutions if you run into problems:

Q. I get an error saying "can't find mdName.dll" or "Entry Point Not Found."
A. This means that mdNameRubyWrapper.dll cannot link to mdName.dll. Please follow the steps in
the Setup section above.



COPYRIGHT NOTICE

(C) 2014 Melissa Data Corporation. All rights reserved.
